Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Editorial] Update the docs based on Copilot review feedback #5332

Merged
merged 3 commits into from
Feb 9, 2024

Conversation

reyang
Copy link
Member

@reyang reyang commented Feb 9, 2024

No description provided.

@reyang reyang requested a review from a team February 9, 2024 03:30
Copy link
Member

@cijothomas cijothomas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how did you use copilot to review :-?

the hot-path. You SHOULD try to keep the number of tags less than or equal to 8.
If you are exceeding this, check if you can model some of the tags as Resource,
as [shown here](#metrics-enrichment).
the hot code path. You SHOULD try to keep the number of tags less than or
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's probably better to keep it as hot-path instead of "hot code path"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CoPilot recommends against "hot-path", a quick search shows that "hot path" and "hot code path" are widely used. e.g. https://www.hackterms.com/hot%20code

docs/logs/README.md Outdated Show resolved Hide resolved
@CodeBlanch CodeBlanch added the documentation Documentation related label Feb 9, 2024
Co-authored-by: Mikel Blanchard <[email protected]>
@utpilla utpilla merged commit f6c31f3 into open-telemetry:main Feb 9, 2024
17 checks passed
@reyang reyang deleted the reyang/doc-copilot-review branch February 9, 2024 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants